<?php ob_start('ob_gzhandler') ?>
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <!--
        /**
        * o------------------------------------------------------------------------------o
        * | This file is part of the RGraph package - you can learn more at:             |
        * |                                                                              |
        * |                          http://www.rgraph.net                               |
        * |                                                                              |
        * | This package is licensed under the RGraph license. For all kinds of business |
        * | purposes there is a small one-time licensing fee to pay and for non          |
        * | commercial  purposes it is free to use. You can read the full license here:  |
        * |                                                                              |
        * |                      http://www.rgraph.net/LICENSE.txt                       |
        * o------------------------------------------------------------------------------o
        */
    -->
    <title>RGraph: HTML5 canvas graph library - pie chart documentation</title>
    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
    <link rel="icon" type="image/png" href="/favicon.png">
</head>
<body>
    <div id="breadcrumb">
        <a href="../index.html">RGraph: HTML5 canvas graph library</a>
        >
        <a href="index.html">Documentation</a>
        >
        Pie chart
    </div>

    <h1>RGraph: HTML5 canvas graph library - Pie chart documentation</h1>

     <script>
        if (document.all) {
            document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer does not natively support the HTML5 canvas tag yet, so if you want to see the graphs, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul></div>');
        }
    </script>

    <p>
        The pie chart can be used, for example, to represent something that is akin to percentages. ie A set of data that
        should be taken as part of a whole.
    </p>
    
    <p> 
        The example file is <a href="../examples/pie.html">here</a>.
    </p> 
    
    <pre class="code">
&lt;script&gt;
    window.onload = function ()
    {
        var data = [564,155,499,611,322];
    
        var pie = new RGraph.Pie('myPie', data);
        pie.Set('chart.labels', ['Abc', 'Def', 'Ghi', 'Jkl', 'Mno']);
        pie.Set('chart.linewidth', 5);
        pie.Set('chart.stroke', '#fff');
        pie.Draw();
    }
&lt;/script&gt;
</pre>


    <h2>Available properties</h2>

    <p>
        You can use these properties to control how the pie chart looks. You can set them by using the Set() method. Eg:
    </p>
    
    <p>
        <b>myPie.Set('name', 'value');</b>
    </p>
    
    <!--
        <PROPERTIES>
            chart.gutter :: The gutter of the graph (for text labels). <br /><i>Default: 25</i>
            chart.align :: Whether to left, center or right align the pie chart.<br /><i>Default: center</i>
            chart.colors :: Colors to be used for the pie segments. <br /><i>Default: ['rgb(255,0,0)', '#ddd', 'rgb(0,255,0)', 'rgb(0,0,255)', 'rgb(255,255,0)', 'rgb(0,255,255)', 'red', 'pink', 'black', 'white']</i>
            chart.strokestyle :: The color of the seperating lines. By setting this to your background color, and setting the linewidth to approx. 5, it will make the pie chart look "exploded". <br /><i>Default: #999</i>
            chart.text.size :: The size of the text (in points). <br /><i>Default: 10</i>
            chart.text.font :: The font used to render the text.<br /><i>Default: Verdana</i>
            chart.text.color :: The color of the labels. <br /><i>Default: black</i>
            chart.labels :: An array of labels to be used for the chart. <br /><i>Default: [] (an empty array)</i>
            chart.labels.sticks :: Stipulates that small sticks for the labels are shown. The <a href="../examples/pie.html">example page</a> has an example of this.<br /><i>Default: false</i>
            chart.labels.sticks.color :: Sets the color of the label sticks.<br /><i>Default: #aaa</i>
            chart.title :: The title of the pie chart. <br /><i>Default: none</i>
            chart.title.color :: The color of the title.<br /> <i>Default: black</i>
            chart.title.vpos :: This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i>
            chart.shadow :: Whether a simple shadow effect is applied. <br /><i>Default: false</i>
            chart.shadow.color :: The color of the shadow. <br /> <i>Default: rgba(0,0,0,0.5)</i>
            chart.shadow.blur :: The severity of the shadow blurring effect. <br /> <i>Default: 3</i>
            chart.shadow.offsetx :: The X offset of the shadow.<br /><i>Default: 3</i>
            chart.shadow.offsety :: The Y offset of the shadow.<br /><i>Default: 3</i>
            chart.linewidth :: By setting this to roughly 5, and setting the strokestyle to the same colour as your background colour,you will get a segment separation effect.<br /><i>Default: 1</i>
            chart.tooltips :: An array of tooltips, starting from the middle right (ie east) axis, and going clockwise sequentially.<br /><i>Default: [] (An empty array)</i>
            chart.tooltip.effect :: The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i>
            chart.highlight.style :: Can be either <i>2d</i> or <i>3d</i> and determines which style of segment highlighting is used in conjunction with tooltips.<br /><i>Default: 2d</i>
            chart.key :: An array of strings used as the key for the chart. This can be used in place of labels if you prefer.<br /><i>Default: null (ie no key is drawn)</i>
            chart.key.background :: The background color of the key.<br /><i>Default: white</i>
            chart.key.shadow :: Whether the key casts a drop shadow.<br /><i>Default: false</i>
            chart.contextmenu :: An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i>
            chart.annotatable :: Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i>
            chart.annotate.color :: If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i>
            chart.zoom.mode :: Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i>
            chart.zoom.factor :: This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i>
            chart.zoom.fade.in :: Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.fade.out :: Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.hdir :: The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i>
            chart.zoom.vdir :: The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i>
            chart.zoom.delay :: The delay (in milliseconds) between frames.<br /><i>Default: 50</i>
            chart.zoom.frames :: The number of frames in the zoom animation.<br /><i>Default: 10</i>
            chart.zoom.shadow :: Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i>
            chart.zoom.thumbnail.width :: When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.thumbnail.height :: When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.background :: Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i>
        </PROPERTIES>
    -->
    
    <!-- DOCS -->

    <table border="0" id="docs">
        <tr>
            <th><a name="chart.gutter"></a>chart.gutter</th>
            <td>The gutter of the graph (for text labels). <br /><i>Default: 25</i></td>
            <th><a name="chart.align"></a>chart.align</th>
            <td>Whether to left, center or right align the pie chart.<br /><i>Default: center</i></td>
        </tr>
        <tr>
            <th><a name="chart.colors"></a>chart.colors</th>
            <td>Colors to be used for the pie segments. <br /><i>Default: ['rgb(255,0,0)', '#ddd', 'rgb(0,255,0)', 'rgb(0,0,255)', 'rgb(255,255,0)', 'rgb(0,255,255)', 'red', 'pink', 'black', 'white']</i></td>
            <th><a name="chart.strokestyle"></a>chart.strokestyle</th>
            <td>The color of the seperating lines. By setting this to your background color, and setting the linewidth to approx. 5, it will make the pie chart look "exploded". <br /><i>Default: #999</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.size"></a>chart.text.size</th>
            <td>The size of the text (in points). <br /><i>Default: 10</i></td>
            <th><a name="chart.text.font"></a>chart.text.font</th>
            <td>The font used to render the text.<br /><i>Default: Verdana</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.color"></a>chart.text.color</th>
            <td>The color of the labels. <br /><i>Default: black</i></td>
            <th><a name="chart.labels"></a>chart.labels</th>
            <td>An array of labels to be used for the chart. <br /><i>Default: [] (an empty array)</i></td>
        </tr>
        <tr>
            <th><a name="chart.labels.sticks"></a>chart.labels.sticks</th>
            <td>Stipulates that small sticks for the labels are shown. The <a href="../examples/pie.html">example page</a> has an example of this.<br /><i>Default: false</i></td>
            <th><a name="chart.labels.sticks.color"></a>chart.labels.sticks.color</th>
            <td>Sets the color of the label sticks.<br /><i>Default: #aaa</i></td>
        </tr>
        <tr>
            <th><a name="chart.title"></a>chart.title</th>
            <td>The title of the pie chart. <br /><i>Default: none</i></td>
            <th><a name="chart.title.color"></a>chart.title.color</th>
            <td>The color of the title.<br /> <i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.title.vpos"></a>chart.title.vpos</th>
            <td>This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i></td>
            <th><a name="chart.shadow"></a>chart.shadow</th>
            <td>Whether a simple shadow effect is applied. <br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.color"></a>chart.shadow.color</th>
            <td>The color of the shadow. <br /> <i>Default: rgba(0,0,0,0.5)</i></td>
            <th><a name="chart.shadow.blur"></a>chart.shadow.blur</th>
            <td>The severity of the shadow blurring effect. <br /> <i>Default: 3</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.offsetx"></a>chart.shadow.offsetx</th>
            <td>The X offset of the shadow.<br /><i>Default: 3</i></td>
            <th><a name="chart.shadow.offsety"></a>chart.shadow.offsety</th>
            <td>The Y offset of the shadow.<br /><i>Default: 3</i></td>
        </tr>
        <tr>
            <th><a name="chart.linewidth"></a>chart.linewidth</th>
            <td>By setting this to roughly 5, and setting the strokestyle to the same colour as your background colour,you will get a segment separation effect.<br /><i>Default: 1</i></td>
            <th><a name="chart.tooltips"></a>chart.tooltips</th>
            <td>An array of tooltips, starting from the middle right (ie east) axis, and going clockwise sequentially.<br /><i>Default: [] (An empty array)</i></td>
        </tr>
        <tr>
            <th><a name="chart.tooltip.effect"></a>chart.tooltip.effect</th>
            <td>The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i></td>
            <th><a name="chart.highlight.style"></a>chart.highlight.style</th>
            <td>Can be either <i>2d</i> or <i>3d</i> and determines which style of segment highlighting is used in conjunction with tooltips.<br /><i>Default: 2d</i></td>
        </tr>
        <tr>
            <th><a name="chart.key"></a>chart.key</th>
            <td>An array of strings used as the key for the chart. This can be used in place of labels if you prefer.<br /><i>Default: null (ie no key is drawn)</i></td>
            <th><a name="chart.key.background"></a>chart.key.background</th>
            <td>The background color of the key.<br /><i>Default: white</i></td>
        </tr>
        <tr>
            <th><a name="chart.key.shadow"></a>chart.key.shadow</th>
            <td>Whether the key casts a drop shadow.<br /><i>Default: false</i></td>
            <th><a name="chart.contextmenu"></a>chart.contextmenu</th>
            <td>An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i></td>
        </tr>
        <tr>
            <th><a name="chart.annotatable"></a>chart.annotatable</th>
            <td>Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i></td>
            <th><a name="chart.annotate.color"></a>chart.annotate.color</th>
            <td>If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.mode"></a>chart.zoom.mode</th>
            <td>Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i></td>
            <th><a name="chart.zoom.factor"></a>chart.zoom.factor</th>
            <td>This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.fade.in"></a>chart.zoom.fade.in</th>
            <td>Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
            <th><a name="chart.zoom.fade.out"></a>chart.zoom.fade.out</th>
            <td>Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.hdir"></a>chart.zoom.hdir</th>
            <td>The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i></td>
            <th><a name="chart.zoom.vdir"></a>chart.zoom.vdir</th>
            <td>The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.delay"></a>chart.zoom.delay</th>
            <td>The delay (in milliseconds) between frames.<br /><i>Default: 50</i></td>
            <th><a name="chart.zoom.frames"></a>chart.zoom.frames</th>
            <td>The number of frames in the zoom animation.<br /><i>Default: 10</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.shadow"></a>chart.zoom.shadow</th>
            <td>Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i></td>
            <th><a name="chart.zoom.thumbnail.width"></a>chart.zoom.thumbnail.width</th>
            <td>When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.thumbnail.height"></a>chart.zoom.thumbnail.height</th>
            <td>When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
            <th><a name="chart.zoom.background"></a>chart.zoom.background</th>
            <td>Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i></td>
        </tr>
        <tr>
        </tr>
    </table><br /><br />

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

</body>
</html>